fix: Resolve compilation warnings related to Javadoc formatting and comment placement #21900
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
rbair23
force-pushed
the
20719-compilation-fails
branch
from
69de3d7 to
98149f7
Compare
rbair23
force-pushed
the
20719-compilation-fails
branch
from
98149f7 to
a03f0f0
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes comment formatting and corrects documentation placement across the codebase. The changes focus on improving code readability and maintaining consistent style guidelines without altering any functional behavior.
Key changes:
- Replaced various separator comment styles (slashes, equals signs) with a uniform dash-based separator format
- Moved misplaced Javadoc and annotation comments to their correct positions before the declarations they document
- Corrected a spelling error from "achive" to "achieve"
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| VirtualMap.java | Removed orphaned comment separator |
| StringLeaf.java | Moved Javadoc from after annotations to before them |
| OutputNoEventsLostValidation.java | Moved @SuppressWarnings annotation from before Javadoc to after |
| EnhancedKeyStoreLoaderTest.java | Standardized section separator format |
| EnhancedKeyStoreLoader.java | Standardized section separator format |
| Utilities.java | Standardized section separator format |
| ConsensusImpl.java | Standardized section separator format |
| SlowMockFCQueue.java | Standardized section separator format across multiple sections |
| MockFCQueue.java | Standardized section separator format across multiple sections |
| FCQueue.java | Standardized section separator format across multiple sections |
| StateBuilder.java | Converted Javadoc-style record field comments to single-line comments |
| TransactionSubmitter.java | Corrected "achive" to "achieve" and moved field Javadoc before field declaration |
| PayloadDistribution.java | Converted trailing Javadoc comment to single-line comment |
| StatsDemoMain.java | Standardized section separator format |
| AtomicTokenCreateSpecs.java | Moved @HapiTestLifecycle annotation from before Javadoc to after |
| SStoreSuite.java | Moved @Tag annotation from before Javadoc comment to after |
| BlockRecordWriterV6.java | Removed orphaned/duplicate Javadoc comment |
| KeyComparatorTest.java | Standardized section separator format across multiple sections |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #21900 +/- ##
============================================
+ Coverage 70.58% 70.62% +0.03%
- Complexity 24329 24341 +12
============================================
Files 2673 2673
Lines 104200 104200
Branches 10936 10936
============================================
+ Hits 73547 73587 +40
+ Misses 26597 26562 -35
+ Partials 4056 4051 -5
... and 21 files with indirect coverage changes 🚀 New features to boost your workflow:
|
Neeharika-Sompalli
approved these changes
Oct 28, 2025
Contributor
Neeharika-Sompalli
left a comment
Neeharika-Sompalli
left a comment
There was a problem hiding this comment.
LGTM! Thanks @rbair23
anthony-swirldslabs
approved these changes
Oct 28, 2025
Contributor
anthony-swirldslabs
left a comment
anthony-swirldslabs
left a comment
There was a problem hiding this comment.
LGTM. Thanks!
imalygin
approved these changes
Oct 28, 2025
rbair23
force-pushed
the
20719-compilation-fails
branch
from
a03f0f0 to
3cd9d03
Compare
netopyr
approved these changes
Oct 29, 2025
...s/tests/PlatformTestingTool/src/main/java/com/swirlds/demo/platform/PayloadDistribution.java
Show resolved
Hide resolved
platform-sdk/swirlds-benchmarks/src/jmh/java/com/swirlds/benchmark/reconnect/StateBuilder.java
Show resolved
Hide resolved
…omment placement Addresses issue #20719 by fixing multiple categories of compiler warnings: - Standardized comment separator formatting to comply with style guidelines - Repositioned annotations to appear after Javadoc comments per Java best practices - Corrected typos in documentation comments - Removed incomplete or orphaned comment fragments Signed-off-by: rbair23 <[email protected]>
rbair23
force-pushed
the
20719-compilation-fails
branch
from
3cd9d03 to
f51f421
Compare
2 tasks
Contributor
|
Tested with JDK25: compiles OK and run NFT 6-hour with TPS=14.1k |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
////...) with cleaner format (// ----...)Details
These changes resolve compilation warnings related to:
Test plan